<!DOCTYPE html>
<html>
<head>
	<meta charset="utf-8">

	<title>SpeechAudioFormat Class Reference</title>

	<link rel="stylesheet" href="../css/style.css">
	<meta name="viewport" content="initial-scale=1, maximum-scale=1.4">
	<meta name="generator" content="appledoc 2.2.1 (build 1333)">
</head>
<body class="appledoc">
	<header>
		<div class="container" class="hide-in-xcode">
			
			<h1 id="library-title">
				<a href="../index.html">SpeechSDK-1_0-for-iOS </a>
			</h1>

			<p id="developer-home">
				<a href="../index.html">Microsoft</a>
			</p>
			
		</div>
	</header>

	<aside>
		<div class="container">
			<nav>
				<ul id="header-buttons" role="toolbar">
					<li><a href="../index.html">Index</a></li>
<li><a href="../hierarchy.html">Hierarchy</a></li>

					<li id="on-this-page" role="navigation">
						<label>
							On This Page

							<div class="chevron">
								<div class="chevy chevron-left"></div>
								<div class="chevy chevron-right"></div>
							</div>

							<select id="jump-to">
	<option value="top">Jump To&#133;</option>
	
	<option value="overview">Overview</option>
	

	
	
	<option value="tasks">Tasks</option>
	
	

	
	
	<optgroup label="Properties">
		
		<option value="//api/name/AverageBytesPerSecond">AverageBytesPerSecond</option>
		
		<option value="//api/name/BitsPerSample">BitsPerSample</option>
		
		<option value="//api/name/BlockAlign">BlockAlign</option>
		
		<option value="//api/name/ChannelCount">ChannelCount</option>
		
		<option value="//api/name/EncodingFormat">EncodingFormat</option>
		
		<option value="//api/name/FormatSpecificData">FormatSpecificData</option>
		
		<option value="//api/name/SamplesPerSecond">SamplesPerSecond</option>
		
	</optgroup>
	

	
	<optgroup label="Class Methods">
		
		<option value="//api/name/create16BitPCMFormat:">+ create16BitPCMFormat:</option>
		
		<option value="//api/name/createSiren7Format:">+ createSiren7Format:</option>
		
	</optgroup>
	

	
	<optgroup label="Instance Methods">
		
		<option value="//api/name/init">- init</option>
		
	</optgroup>
	
	
</select>
						</label>
					</li>
				</ul>
			</nav>
		</div>
	</aside>

	<article>
		<div id="overview_contents" class="container">
			<div id="content">
				<main role="main">
					<h1 class="title">SpeechAudioFormat Class Reference</h1>

					
					<div class="section section-specification"><table cellspacing="0"><tbody>
						<tr>
	<th>Inherits from</th>
	<td>NSObject</td>
</tr><tr>
	<th>Declared in</th>
	<td>SpeechAudioFormat.m<br />SpeechRecognitionService.h</td>
</tr>
						</tbody></table></div>
					

                    
					
					<div class="section section-overview">
						<a title="Overview" name="overview"></a>
						<h2 class="subtitle subtitle-overview">Overview</h2>
						<p>The SpeechAudioFormat contains information about how the audio data was recorded and stored, including the type of compression used, number of channels, sample rate, bits per sample and other attributes.</p>
					</div>
					
					

					
					
					<div class="section section-tasks">
						<a title="Tasks" name="tasks"></a>
						

						
						<h2 class="task-title">Other Methods</h2>

						<div class="task-list">
							<div class="section-method">
	<a name="//api/name/init" title="init"></a>
	<h3 class="method-title"><code><a href="#//api/name/init">&ndash;&nbsp;init</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Initializes a SpeechAudioFormat object</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>- (id)init</code></div>

		    
			

			

			

			
			<div class="method-subsection discussion-section">
				<h4 class="method-subtitle">Discussion</h4>
				<p>Initializes a SpeechAudioFormat object</p>
			</div>
			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">SpeechAudioFormat.m</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/createSiren7Format:" title="createSiren7Format:"></a>
	<h3 class="method-title"><code><a href="#//api/name/createSiren7Format:">+&nbsp;createSiren7Format:</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Produces a SpeechAudioFormat for data encoded in Siren7.  The data must be encoded in mono, such that a 320 sample mono input frame produces a 40 bytes output frame.</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>+ (SpeechAudioFormat *)createSiren7Format:(int)<em>sampleRate</em></code></div>

		    
			
			<div class="method-subsection arguments-section parameters">
				<h4 class="method-subtitle parameter-title">Parameters</h4>
				<table class="argument-def parameter-def">
				
					<tr>
						<th scope="row" class="argument-name"><code>sampleRate</code></th>
						<td><p>The samples per second of the audio that was encoded (can only be 16000).</p></td>
					</tr>
				
				</table>
			</div>
			

			
			<div class="method-subsection return">
				<h4 class="method-subtitle parameter-title">Return Value</h4>
				<p>The created SpeechAudioFormat.</p>
			</div>
			

			

			
			<div class="method-subsection discussion-section">
				<h4 class="method-subtitle">Discussion</h4>
				<p>Produces a SpeechAudioFormat for data encoded in Siren7.  The data must be encoded in mono, such that a 320 sample mono input frame produces a 40 bytes output frame.</p>
			</div>
			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">SpeechAudioFormat.m</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/create16BitPCMFormat:" title="create16BitPCMFormat:"></a>
	<h3 class="method-title"><code><a href="#//api/name/create16BitPCMFormat:">+&nbsp;create16BitPCMFormat:</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Produces a SpeechAudioFormat for 16-bit PCM data.</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>+ (SpeechAudioFormat *)create16BitPCMFormat:(int)<em>sampleRate</em></code></div>

		    
			
			<div class="method-subsection arguments-section parameters">
				<h4 class="method-subtitle parameter-title">Parameters</h4>
				<table class="argument-def parameter-def">
				
					<tr>
						<th scope="row" class="argument-name"><code>sampleRate</code></th>
						<td><p>The samples per second of the audio that was encoded (can only be 16000).</p></td>
					</tr>
				
				</table>
			</div>
			

			
			<div class="method-subsection return">
				<h4 class="method-subtitle parameter-title">Return Value</h4>
				<p>The created SpeechAudioFormat.</p>
			</div>
			

			

			
			<div class="method-subsection discussion-section">
				<h4 class="method-subtitle">Discussion</h4>
				<p>Produces a SpeechAudioFormat for 16-bit PCM data.</p>
			</div>
			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">SpeechAudioFormat.m</code></p>
			</div>
			
			
		</div>
	</div>
</div>
						</div>
						

						
						<h2 class="task-title">Other Methods</h2>

						<div class="task-list">
							<div class="section-method">
	<a name="//api/name/AverageBytesPerSecond" title="AverageBytesPerSecond"></a>
	<h3 class="method-title"><code><a href="#//api/name/AverageBytesPerSecond">&nbsp;&nbsp;AverageBytesPerSecond</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>This value indicates how many bytes of audio data must be streamed to a D/A converter per second in order to play the audio.</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>@property (nonatomic, assign) int AverageBytesPerSecond</code></div>

		    
			

			

			

			
			<div class="method-subsection discussion-section">
				<h4 class="method-subtitle">Discussion</h4>
				<p>This value indicates how many bytes of audio data must be streamed to a D/A converter per second in order to play the audio.</p>
			</div>
			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">SpeechRecognitionService.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/BitsPerSample" title="BitsPerSample"></a>
	<h3 class="method-title"><code><a href="#//api/name/BitsPerSample">&nbsp;&nbsp;BitsPerSample</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>The number of significant bits in each audio sample. Usually 16 or 24.</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>@property (nonatomic, assign) short BitsPerSample</code></div>

		    
			

			

			

			
			<div class="method-subsection discussion-section">
				<h4 class="method-subtitle">Discussion</h4>
				<p>The number of significant bits in each audio sample. Usually 16 or 24.</p>
			</div>
			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">SpeechRecognitionService.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/BlockAlign" title="BlockAlign"></a>
	<h3 class="method-title"><code><a href="#//api/name/BlockAlign">&nbsp;&nbsp;BlockAlign</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>The number of data bytes per sample slice.</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>@property (nonatomic, assign) short BlockAlign</code></div>

		    
			

			

			

			
			<div class="method-subsection discussion-section">
				<h4 class="method-subtitle">Discussion</h4>
				<p>The number of data bytes per sample slice.</p>
			</div>
			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">SpeechRecognitionService.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/ChannelCount" title="ChannelCount"></a>
	<h3 class="method-title"><code><a href="#//api/name/ChannelCount">&nbsp;&nbsp;ChannelCount</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>The number of separate audio signals in the audio data. A value of 1 means a mono signal, a value of 2 means a stereo signal.</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>@property (nonatomic, assign) short ChannelCount</code></div>

		    
			

			

			

			
			<div class="method-subsection discussion-section">
				<h4 class="method-subtitle">Discussion</h4>
				<p>The number of separate audio signals in the audio data. A value of 1 means a mono signal, a value of 2 means a stereo signal.</p>
			</div>
			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">SpeechRecognitionService.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/EncodingFormat" title="EncodingFormat"></a>
	<h3 class="method-title"><code><a href="#//api/name/EncodingFormat">&nbsp;&nbsp;EncodingFormat</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Specifies the type of compression used on the audio data. Default value is AudioCompressionType_PCM.</p>

			</div>
			
		    

			<div class="method-subsection method-declaration"><code>@property (nonatomic, assign) AudioCompressionType EncodingFormat</code></div>

		    
			

			

			

			
			<div class="method-subsection discussion-section">
				<h4 class="method-subtitle">Discussion</h4>
				<p>Specifies the type of compression used on the audio data. Default value is AudioCompressionType_PCM.</p>

			</div>
			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">SpeechRecognitionService.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/FormatSpecificData" title="FormatSpecificData"></a>
	<h3 class="method-title"><code><a href="#//api/name/FormatSpecificData">&nbsp;&nbsp;FormatSpecificData</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Extra bytes for use to describe parameters to certain audio compression types.</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>@property (nonatomic, strong) NSData *FormatSpecificData</code></div>

		    
			

			

			

			
			<div class="method-subsection discussion-section">
				<h4 class="method-subtitle">Discussion</h4>
				<p>Extra bytes for use to describe parameters to certain audio compression types.</p>

<p>This field should be null for PCM.</p>

			</div>
			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">SpeechRecognitionService.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/SamplesPerSecond" title="SamplesPerSecond"></a>
	<h3 class="method-title"><code><a href="#//api/name/SamplesPerSecond">&nbsp;&nbsp;SamplesPerSecond</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Audio sample slices per second, where one slice includes all the channel samples. This value is unaffected by the number of channels.</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>@property (nonatomic, assign) int SamplesPerSecond</code></div>

		    
			

			

			

			
			<div class="method-subsection discussion-section">
				<h4 class="method-subtitle">Discussion</h4>
				<p>Audio sample slices per second, where one slice includes all the channel samples. This value is unaffected by the number of channels.</p>
			</div>
			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">SpeechRecognitionService.h</code></p>
			</div>
			
			
		</div>
	</div>
</div>
						</div>
						
					</div>
					
					

                    
				</main>

				<footer>
					<div class="footer-copyright">
						
						<p class="copyright">Copyright &copy; 2016 Microsoft. All rights reserved. Updated: 2016-03-21</p>
						
						
						<p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1333)</a>.</p>
						
					</div>
				</footer>
			</div>
		</div>
	</article>

	<script src="../js/script.js"></script>
</body>
</html>